/*
 * Copyright (C) 2017-2019 Dremio Corporation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.dremio.datastore.api;

import org.immutables.value.Value.Immutable;

import com.fasterxml.jackson.databind.annotation.JsonDeserialize;

/**
 * Representation of a document in the KV Store.
 *
 * @param <K> the Key type.
 * @param <V> the Value type.
 */
@JsonDeserialize(builder = ImmutableDocument.Builder.class)
@Immutable
public interface Document<K, V> {
  /**
   * Get the key corresponding to this document.
   *
   * @return key of this document.
   */
  K getKey();

  /**
   * Get the value corresponding to this document.
   *
   * @return value of this document.
   */
  V getValue();

  /**
   * Get the version tag of this document.
   *
   * @return version tag of this document.
   */
  String getTag();
}
